Skip to content

Fixes for class 1#14

Merged
andrewrosemberg merged 9 commits into
mainfrom
mk/c1fix
Aug 14, 2025
Merged

Fixes for class 1#14
andrewrosemberg merged 9 commits into
mainfrom
mk/c1fix

Conversation

@klamike

@klamike klamike commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator

WIP

@klamike

klamike commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator Author

Note all interactive elements are broken in the HTML preview. I think the recent BonitoBook.jl (tries to?) fix this (though it seems you would have to write JS code which.. is probably not worth it)

Comment thread class01/class01_intro.jl Outdated
@klamike

klamike commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator Author
┌ Warning: Cannot extract version for inventory from /home/runner/work/LearningToControlClass/LearningToControlClass/Project.toml: no such file
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/eoWm2/src/html/write_inventory.jl:89
┌ Warning: Please set `inventory_version` in the `HTML()` options passed to `makedocs`.
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/eoWm2/src/html/write_inventory.jl:98

is this a problem?

@klamike

klamike commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator Author

CI took almost an hour! Is that expected?

@andrewrosemberg

Copy link
Copy Markdown
Member
┌ Warning: Cannot extract version for inventory from /home/runner/work/LearningToControlClass/LearningToControlClass/Project.toml: no such file
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/eoWm2/src/html/write_inventory.jl:89
┌ Warning: Please set `inventory_version` in the `HTML()` options passed to `makedocs`.
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/eoWm2/src/html/write_inventory.jl:98

is this a problem?

Not a problem. its just that Documenter expects there to be a package but this repo is not structred as a package.

@andrewrosemberg

Copy link
Copy Markdown
Member

CI took almost an hour! Is that expected?

Not expected. It takes somewhere between 3 to 13 minutes for me (see https://github.com/LearningToOptimize/LearningToControlClass/actions/runs/16893071727). Perhaps it is the CI documenter verion change?

@klamike

klamike commented Aug 12, 2025

Copy link
Copy Markdown
Collaborator Author

CI took almost an hour! Is that expected?

Not expected. It takes somewhere between 3 to 13 minutes for me (see https://github.com/LearningToOptimize/LearningToControlClass/actions/runs/16893071727). Perhaps it is the CI documenter verion change?

Ah yeah probably due to the 1.10.6 pin I tried to get rid of the warning. Trying out just removing the manifest file now, do you think it's important to commit them?

@andrewrosemberg

Copy link
Copy Markdown
Member

Not expected. It takes somewhere between 3 to 13 minutes for me (see https://github.com/LearningToOptimize/LearningToControlClass/actions/runs/16893071727). Perhaps it is the CI documenter verion change?

Ah yeah probably due to the 1.10.6 pin I tried to get rid of the warning. Trying out just removing the manifest file now, do you think it's important to commit them?

I want to avoid any students having problems with versions, and this is the usual way people prepare workshops. Nevertheless, I am thinking that we can probably just make each person compile their own pluto when submitting a class. This way we the manifests and project tomls of each class won't influence the documenter anymore.

@klamike klamike marked this pull request as ready for review August 14, 2025 19:45
@andrewrosemberg andrewrosemberg self-assigned this Aug 14, 2025

@andrewrosemberg andrewrosemberg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@andrewrosemberg andrewrosemberg merged commit 539074f into main Aug 14, 2025
2 checks passed
@andrewrosemberg andrewrosemberg deleted the mk/c1fix branch August 18, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants